DisposeActionState

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODPart

DisposeActionState
The DisposeActionState method should dispose of the undo action data.
void DisposeActionState (in ODActionData actionState,
                         in ODDoneState doneState);
actionState
A byte array whose buffer contains the data previously logged by this part to allow it to undo the action.
doneState
The state of the undo action. The value of doneState must be one of the following: kODDone, kODReDone, or kODUndone.

DISCUSSION
The values kODDone and kODReDone for the doneState parameter indicate that the action was on the document's undo stack. The value kODUndone indicates that the action was on the document's redo stack.
OpenDoc calls this method when it disposes of the undo action data. After this method executes successfully, memory for the action state is reclaimed and is no longer usable for undo operations, effectively committing the action.

OVERRIDING
When you subclass ODPart, you can override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely.

EXCEPTIONS

kODErrDoesNotUndo
The specified action is not an undo action of this part.

SEE ALSO
The ODActionData type (page 898).
The ODDoneState type (page 899).
The ODPart::ReadActionState method (page 536).
The ODPart::WriteActionState method (page 552).
Table 2-1 on page 89 in OpenDoc Programmer's Guide.
"Removing an Embedded Frame" on page 121 in OpenDoc Programmer's Guide.
"Implementing Undo" on page 258 in OpenDoc Programmer's Guide.
"Undo and Embedded Frames" on page 262 in OpenDoc Programmer's Guide.
"Handling Cut Data" on page 334 in OpenDoc Programmer's Guide.
"Undo for Clipboard" on page 354 in OpenDoc Programmer's Guide.